home *** CD-ROM | disk | FTP | other *** search
/ Pluspack 1 / Caligari Corporation Pluspack1 1998.iso / TSX_SDK / tsxINC / tsxGroup.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-01-28  |  3.4 KB  |  72 lines
  1. //******************************************************************************
  2. //    File: tsxGroup.cpp
  3. //  Module: trueSpace eXtensions API
  4. //   Descr: Definition of tsxGROUP
  5. //******************************************************************************
  6.  
  7. #ifndef TSXGROUP_H
  8. #define TSXGROUP_H
  9.  
  10. #include "tsxTypes.h"
  11.  
  12. //------------------------------------------------------------------------------
  13. //------------------------------------------------------------------------------
  14.  
  15. // Only tsxGNODE types can be grouped together. The children of a group
  16. // may be any tsxGNODE derived type.
  17.  
  18. //------------------------------------------------------------------------------
  19. //    Making Groups
  20. //------------------------------------------------------------------------------
  21.  
  22. // The grouping mechanism (currently) only works with the currently selected obj.
  23.  
  24. // This is the same function as used in the [Glue as Child] button.
  25. // (Currobj = currently selected object)
  26. // Makes pGNode and Currobj children of a new Group obj, and
  27. // the Group obj is placed where Currobj was in the Scene Graph.
  28. // The new Group obj becomes the current selection, and acquires
  29. // the previous Currobj's axes position and orientation.
  30. // The animation timeline window is updated.
  31. // pGNode and Currobj must have different Roots (`tsxGNodeGetRoot').
  32. // Returns: 0 if no pGNode or Currobj, or not valid GNodes, or
  33. //          if pGNode is same as Currobj (no grouping done), else
  34. //          ptr to the new Group obj.
  35. TSXAPIFN tsxGROUP* tsxGroupNewWithCurrobj( tsxGNODE* pGNode );
  36.  
  37. // This is the same function as used in the [Glue as Sibling] button.
  38. // (Currobj = currently selected object)
  39. // IF Currobj is a Group node,
  40. // THEN pGNode is added to it as another child;
  41. // ELSE 
  42. //   Makes pGNode and Currobj children of a new Group obj, and
  43. //   the Group obj is placed where Currobj was in the Scene Graph.
  44. //   The new Group obj becomes the current selection, and acquires
  45. //   the previous Currobj's axes position and orientation.
  46. // The animation timeline window is updated.
  47. // pGNode and Currobj must have different Roots (`tsxGNodeGetRoot').
  48. // pGNode must be a top level object (no parent groups above it).
  49. // Returns: 0 if no pGNode or Currobj, or not valid GNodes, or
  50. //          if pGNode is same as Currobj (no grouping done), else
  51. //          ptr to the (new or Currobj) Group obj.
  52. TSXAPIFN tsxGROUP* tsxGroupAtCurrobj( tsxGNODE* pGNode );
  53.  
  54. // This is the same function as used in the [Unglue] button.
  55. // Currobj is removed from its parent Group and added as a top level object
  56. // to the scene.  Current selection is updated to next available sibling.
  57. // Side Effect: If the Currobj has only one sibling before calling this
  58. //    function, then the parent GROUP object is removed and the sibling takes
  59. //    the place in the scene graph of the removed GROUP object. Thus this
  60. //    function never results in a Group object with just one child.
  61. // (Parent = parent GROUP of Currobj before calling this function)
  62. // Returns:  
  63. //   0   on failure (e.g. No Currobj, Currobj not part of group), else
  64. //   ptr to oject that takes the place of Parent in the scene graph
  65. //   (see note on Side Effect):
  66. //     = Parent if it had more than 2 children before this function, else
  67. //       = the sibling that replaces Parent.
  68. TSXAPIFN tsxGNODE* tsxGroupRemoveCurrobj();
  69.  
  70. //******************************************************************************
  71. #endif //TSXGROUP_H
  72.